Location: PHPKode > scripts > phpRetrieve > phpRetrieve/help.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<!-- This template can be downloaded from www.openwebdesign.org. Just search for neuphoric -->

<!-- This template has been modified by mejobloggs (http://www.openwebdesign.org/userinfo.phtml?user=mejobloggs) -->

<!-- Please use this template according to the license on the original template (included as pleaseread.txt) -->

<!-- The original of this template was designed by http://www.tristarwebdesign.co.uk - please visit for more templates & information - thank you. -->



	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

	<link rel="stylesheet" type="text/css" href="styles.css" />

<script type="text/javascript">

  var _gaq = _gaq || [];

  _gaq.push(['_setAccount', 'UA-11507900-14']);


  (function() {

    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);




<body id="altbody">

<div id="wrapper-header">

	<div id="header">




<div id="wrapper-menu">

	<div id="menu">


			<li><a title="Home Page" href="http://www.phpretrieve.com/index.html">home</a></li>

			<li><a title="Demo" href="http://www.phpretrieve.com/phpRetrieve/index.php" target="_blank">online demo</a></li>

			<li><a title="Download phpRetrieve" href="http://www.phpretrieve.com/download.html">download</a></li>

			<li><a title="Install & Use Help" href="http://www.phpretrieve.com/help.html">help</a></li>

			<li><a title="Contact Us" href="http://www.phpretrieve.com/contact.html">contact</a></li>




<div id="content">

	<strong><big>phpRetrieve - Free MySQL database query tool.</big><strong>


	<br/><br/><h2>Installation Help</h2>


		<li>Requirements : phpRetrieve is a web based reporting tool for querying data in a MySQL database 

			and built using php. phpRetrieve assumes you already have these technologies installed and running

			on your server or computer.</li>

		<br/><br/><li>Download : Follow the link on the menu bar and download the phpRetrieve zip file.  Unzip it and

			copy the phpRetrieve folder to your web folder.</li>

		<br/><br/><li>Setup Configuration File : As a minimum the phpRetrieve configuration file needs the access details

			for your MySQL database. Within the phpRetrieve folder locate the file 'config.php' and open in a text editor.

			Complete the 'user', 'password' and 'database' strings with a valid database and user credentials.

			Note : You should create a user on your database with 'Select' only access to your data for use with


		<br/><br/><li>Multi-User : phpRetrieve supports multiple users, with each user being able to create their own private

			reports or publish them to all users. By default phpRetrieve assumes the username is 'Guest' unless

			an alternative username is passed to it.  phpRetrieve has no login screen but usernames can be passed as

			a query string.

			<br/>As an example of passing a username, enter the following into your web browsers address bar,

			'localhost/phpRetrieve/index.php?user=Mark', replacing 'localhost' with your own sites URL.

			phpRetrieve will now think the current user is called Mark, as displayed in the bottom left of the

			browser window.

			<br/>The passing of usernames is managed by a php script file called 'setUser.php' which can be

			customised to your needs.</li>

		<br/><br/><li>Hiding Tables : phpRetrieve can be configured not to show specified tables in the navigation pane.

			Within the phpRetrieve configuration file called 'config.php', simply add the tables to be hidden to the array

			$exclude[], as per the example shown.</li>

		<br/><br/><li>Copy Reports : Reports saved by users are stored in a folder called 'Reports' within the phpRetrieve

			folder. The reports can be freely deleted, copied, moved, etc.</li>



	<br/><br/><h2>Help Using phpRetrieve :</h2>


		<li>Select a Table : In the left hand pane, click on the table you wish to query against. All available

			fields will be listed in the right hand pane.</li>

		<br/><br/><li>Select Fields and add Criteria : If no selections are made against the fields then phpRetrieve will

			try and retrieve all fields and all records. To select specific fields click the tick box against

			each one required. Against each field criteria can be added to filter the data. phpRetrieve supports

			the use of the wildcard '%' which can be used with the 'LIKE' criteria.</li>

		<br/><br/><li>Run & Export : Click the 'Run' button and a snippet of data will be shown, (the first 200 records). The

			data can be exported by clicking 'ExportCSV' or 'ExportXML' buttons. The XML export is a file format

			supported by Excel 2003 and later versions. The Excel export is limited to the first 65,000 records.

			This limit can be increased by the system administrator in the phpRetrieve configuration file.

			Files exported are first zipped to reduce network bandwidth.</li>

		<br/><br/><li>Advanced Queries : Advanced users can edit and create MySQL queries directly by clicking on 'ViewMySQL'

			and editing the code in the box. Once a query is edited in advanced mode it can not be edited in the

			standard design mode.</li>

		<br/><br/><li>Saving Reports : Reports can be saved by clicking the 'Save' button and adding a name for your query or

			report.  Reports can be kept private, shared as read only or shared for editing by ticking the appropriate

			'Share' tick box.</li>






<div id="footer">

	original design by <a title="derby web design" rel="nofollow" href="http://www.tristarwebdesign.co.uk">tri-star web design</a>



Return current item: phpRetrieve