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 text mode 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 simple web based MySQL query interface and 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 are virtually hosted and they only have access to their database, 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
- Session support so you may leave MyClient and return without having to login again.
- Three SQL query interface windows with query memory that allows you to switch between at will.
- Ability to save and load query files to/from disk.
- One button table describe functionality.
- A table dump feature to dump the contents of a table to the screen or to a file. The data delimiter and separators may be defined as any three character combination.
- Character set support to allow for (rudemetary) foreign language support.
- Optional intergrated link to launch phpMyAdmin.
- Optional intergrated link to launch phpMyDoc.
- Intergrated documentation.
Requirements
- PHP4 >= 4.0.6 (because of session requirements)
- MySQL (Known to work with anything above 3.21.x)
- Web Server (Known to work on Apache with mod_php or with PHP as a CGI)
- Web Browser w/cookies enabled (Tested w/NS 4.7x, 6.x, IE5.x, 6.x, Opera 6.x, NeoPlanet 5.2)
Installation
- Download a MyClient release.
- 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)
-
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!
-
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.
-
Either rename the directory to "myclient" or create a "myclient" symbolic link to the current release directory.
-
Point your web browser at: http://www.yoursite.com/myclient/
-
Optionally you may want make some changes to the configuration options explained below by creating a local configuration file named "myclient_cfg.local.php".
-
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.
|
Default Connection
|
Option
|
Default Value
|
Description
|
|
|
$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.
|
|
|
$mode_default
|
0
|
Controls which interface is the default: 0 = SQL Interface, 1 = Table Dump
|
|
|
$session_save_path
|
NULL
|
Controls where session data is stored. If no value is specified, the PHP default of /tmp will be used. 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.
|
|
|
|
Table Dump Options
|
Option
|
Default Value
|
Description
|
|
|
$default_delimiter
|
" (double quote)
|
The default data delimiter for table data dumps.
|
|
|
$default_separator
|
, (comma)
|
The default data separator for table data dumps.
|
|
|
|
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.
|
|
|
|
|
$pmd_enable
$default_delimiter
|
0
|
Enable phpMyDoc link in MyClient menu.
|
|
|
$pmd_location
|
/path/to/phpMyAdmin/
|
The path to the phpMyDoc application
|
|
|
$pmd_window
|
_blank
|
Launch phpMyDoc application in a separate window. "_self" will launch it in the current browser window. This setting was added in MyClient V2.1.
|
|
|