MyClient Documentation

  MyClient User Documentation
 
  Introduction
  Features
  Requirements
  Installation
  Configuration Options

Introduction

The most current version of this documentation can always be found on the MyClient homepage.

MyClient is a simple MySQL Web Client Interface. Largely it is a web-ified version of the "MySQL" command-line query interface. It does not contain a lot of bells and whistles like some other MySQL administrative oriented programs. 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. This was one of the primary reason this application was developed. MyClient allows you to quickly and easily connect and rule your little corner of the MySQL universe.

Features
Requirements
Installation
  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_v13" for MyClient V1.3)
  3. New Users:
    • In the MyClient directory, create and edit the myclient_cfg.local.php file to set your default database connection values if desired. By default, login values are null and the default server is set to localhost.
    • Other options may be set if you so desire, but MyClient will run without any configuration changes. You SHOULD NOT make changes to the myclient_cfg.php file. Rather, create a myclient_cfg.local.php file and put your overriding changes there.
    • View the README file!
  4. Upgrading Users:
    • Those upgrading from a previous release should see the "README" file and look at the "UPGRADE" file that may contain special upgrade configuration instructions. If you do not find any such special instructions, simply copy your local configuration file (myclient_cfg.local.php) to the current release directory.
  5. Either rename the directory to "myclient" or create a "myclient" symbolic link to the current release directory.
  6. Point your web browser at: http://www.yoursite.com/myclient/
  7. Optionally you may want make some changes to the configuration options explained below by creating a local configuration file named "myclient_cfg.local.php".
  8. Enjoy!
Configuration Options

There are a number of user configurable options that affect the way MyClient looks and behaves. These may be adjusted by creating a local configuration file named "myclient_cfg.local.php". Below is a listing of the various configuration sections, their option values with their default values and an explanation of what each option does.

Database Connection Option Default Value Description
  $db_connect_type standard Specifies whether to create a standard or a persistent database connection. Available options are "standard" or "persistent". Persistent connections provide a significant performance advantage, but please read the PHP manual regarding persistent database connections and the mysql_pconnect function before using this option. This setting was added in MyClient V2.3.
  $db_name_default NULL This is the default database name which you want to display as the default on the logon screen. If left at the default NULL string setting you will need to enter the database name when you want to login. This may be useful if you connect to many different database hosts.
  $db_user_default NULL This is the default login username which you want to display as the default on the logon screen. If left at the default NULL string setting you will need to enter the username when you want to login. This may be useful if you often connect to one or more databases using the same username.
  $db_host_default localhost This is the default database host which you want to display as the default on the logon screen. If you are connecting to a local database, this should be left at the default localhost value. Optionally you can set it to a remote or fully qualified host name. If set to the NULL string, you will need to enter the database name when you want to login. This may be useful if you connect to many different database hosts.
  $db_port_default 3306 This is the default database port number which you want to display as the default on the logon screen. Generally this should be left at the default 3306 value unless you know the server is operating on a different port. This setting was added in MyClient V2.0.
  $db_name_list UNDEF This is an optional default setting. If this variable is set and is an array, a pick list of databases will be presented on the login screen. If this variable is not set or is not an array, a textbox will be displayed and contain the value of $db_name_default. This setting was added in MyClient V2.2.
  $db_user_list UNDEF This is an optional default setting. If this variable is set and is an array, a pick list of users will be presented on the login screen. If this variable is not set or is not an array, a textbox will be displayed and contain the value of $db_user_default. This setting was added in MyClient V2.2.

General Options Option Default Value Description
  $set_time_limit 180 This sets the value in seconds of the PHP set_time_limit() function. If you run a lot of very large queries and start getting PHP timeout messages, you may need to increase this setting.
  $session_save_path /tmp/ Controls where session data is stored. This is a major security risk, particularly if you are using MyClient on a virtually hosted server. It is HIGHLY RECOMMENDED that this be set to a directory within your user directory space if you are running on a virtual host. The directory permissions must be set such that the web process can read and write to this directory to maintain your session data. If you choose to use a directory within your web space, you should create a ".htaccess" file to prevent a browser from being able to view the contents of the directory. This setting was added in MyClient V1.32a.
  $session_timeout 8 Maximum length of time in hours that a session remains valid. This setting was added in MyClient V2.1.1.
  $db_switch_enable true Enable/disable the ability to dynamically switch databases from the query window without having to logout and log back in. This setting was added in MyClient V2.3.
  $db_switch_mode dynamic Selects whether the database switching list is dynamically generated or whether the $db_name_list is used. Available options are "dynamic" or "myclient". For those who are using MyClient where they don't have MySQL root access (e.g. vitual web hosting) the "myclient" option is recommended. This setting was added in MyClient V2.3.
  $enable_gz_output true Enable/Disable Gzip content output compression. Please see the V2.4.2 section of the "HISTORY" document for a possible problem with this option. This setting was added in MyClient V2.4.2.
  $gz_level 6 Sets the compression rate for the GZip page output compression. The default of 6 is a reasonable compromise between speed and compression ratio. On fast systems or system where your bandwidth usage is an issue, you may want to increase this to the maximum of 9. This setting was added in MyClient V2.4.2.
  $enable_table_sort true Enables/Disables query result column sorting. This feature uses JavaScript, so if you are opposed to that, you can disable it and the JavaScript will go away. You can learn more about this modo-cool feature by going here. This setting was added in MyClient V2.5.

Dump Options Option Default Value Description
  $default_delimiter " (double quote) The default data delimiter of the results for the "Save Results" option.
  $default_separator , (comma) The default data separator of the results for the "Save Results" option.
  $dump_enable_download true Enable/disable file downloading of results for the "Save Results" option. This setting was added in MyClient V2.3.
  $dump_enable_file true Enable/disable file saving of results for the "Save Results" option. This setting was added in MyClient V2.3.
  $dump_enable_email true Enable/disable e-mailing of results for the "Save Results" option. This setting was added in MyClient V2.3.
  $default_dump_mode true The default results mode for the "Save Results" option. Available options are "download","file" or "email". This setting was added in MyClient V2.3.
  $default_dump_dir /tmp/ The default save or working directory for the "Save Results" option. The directory permissions must be such that the web process can read and write to this directory. This setting was added in MyClient V2.3.
  $default_dump_email NULL The default e-mail address when e-mail results is enabled for the "Save Results" option. This setting was added in MyClient V2.3.
  $default_inc_col_names true Enable/disable to include the query column names in the results file for the "Save Results" option. This setting was added in MyClient V2.3.
  $default_replace_newline false Default enable/disable to replace newline characters in the results file for the "Save Results" option. This setting was added in MyClient V2.3.
  $default_newline_fill NULL Default replacement character(s) when the "replace newline characters" is selected for the "Save Results" option. The default of NULL will cause newline characters within the results set to be stripped out. This setting was added in MyClient V2.3.

Display Properties Option Default Value Description
  $charset iso-8859-1 The display character set. This setting was added in MyClient V2.0.
  $display_query_cols 90 The width in columns of the SQL Query Interface window. This setting was changed in MyClient V2.1.1
  $display_query_rows 10 The height in rows of the SQL Query Interface window.
  $display_page_bg #B3D9D9 The page background color.
  $display_hdr_bg #7E9AC7 The color of displayed table headers.
  $display_row_bg #CDC19C & #E2E2C7 The alternating table row colors for returned results.
  $display_error_color red The font color for error notices. This affect only the pre-text message, not the full message text.
  $display_summary red The font color for the number of rows returned when a query is executed.

Supplemental Programs Option Default Value Description
  $pma_enable $default_delimiter 0 Enable phpMyAdmin link in MyClient menu.
  $pma_location /path/to/phpMyAdmin/ The path to the phpMyAdmin application
  $pma_window _blank Launch phpMyAdmin application in a separate window. "_self" will launch it in the current browser window. This setting was added in MyClient V2.1.