* Documentation.html:
            - Updates for SQL Parser

            2002-08-08 Robin Johnson  <robbat2@users.sourceforge.net>
                * Documentation.html:
                        - Cleaned up and re-arranged Configuration section to match
                                  config.inc.php3
                                      * config.inc.php3:
                                              - Cleaned up and re-arranged Configuration section to match
                                                        config.inc.php3
This commit is contained in:
Robin Johnson
2002-08-09 09:37:28 +00:00
parent 4ef1523e7a
commit 39351fc09b
3 changed files with 238 additions and 131 deletions

View File

@@ -5,6 +5,19 @@ phpMyAdmin - Changelog
$Id$
$Source$
2002-08-09 Robin Johnson <robbat2@users.sourceforge.net>
* Documentation.html:
- Updates for SQL Parser
2002-08-08 Robin Johnson <robbat2@users.sourceforge.net>
* Documentation.html:
- Cleaned up and re-arranged Configuration section to match
config.inc.php3
* config.inc.php3:
- Cleaned up and re-arranged Configuration section to match
config.inc.php3
2002-08-08 Lo<4C>c Chapeaux <lolo@phpheaven.net>
* left.php3: xhtml fixes (id name must start with a letter).
* pdf_pages.php3, tbl_printview.php3, tbl_realtion.php3,

View File

@@ -437,7 +437,15 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
<tt>$HTTP_SERVER_VARS</tt> or <tt>$GLOBALS</tt> in this case.
<br /><br />
</dd>
<dt><b>$cfg['PmaAbsoluteUri_DisableWarning']</b> boolean</dt>
<dd>
By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
detects your absolute URI automatically, we display a warning to remind
you. If you have tested the automatic detection, and it works perfectly
for your setup, then you can set this variable to squelch the warning.
<br /><br />
</dd>
<dt><b>$cfg['PmaNoRelation_DisableWarning']</b> boolean</dt>
<dd>
Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
@@ -976,11 +984,17 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
displayed when you're about to loose data.
<br /><br />
</dd>
<dt><b>$cfg['ShowTooltip'] </b>boolean</dt>
<dt><b>$cfg['LoginCookieRecall'] </b>boolean</dt>
<dd>
Defines whether to display table comment as tooltip in left frame or
not.
Define whether the previous login should be recalled or not in cookie
authentication mode.
<br /><br />
</dd>
<dt><b>$cfg['UseDbSearch'] </b>boolean</dt>
<dd>
Define whether the "search string inside database" is enabled or not.
<br /><br />
</dd>
@@ -990,6 +1004,22 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
tables in the left frame (smaller page).
<br /><br />
</dd>
<dt><b>$cfg['ShowTooltip'] </b>boolean</dt>
<dd>
Defines whether to display table comment as tooltip in left frame or
not.
<br /><br />
</dd>
<dt><b>$cfg['ShowStats'] </b>boolean</dt>
<dd>
Defines whether to display space usage and statistics about databases
and tables or not.<br />
Note that statistics requires at least MySQL 3.23.3 and that, at this
date, MySQL doesn't return such information for Berkeley DB tables.
<br /><br />
</dd>
<dt>
<b>$cfg['ShowMysqlInfo'] </b>boolean<br />
@@ -1024,28 +1054,6 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
<br /><br />
</dd>
<dt><b>$cfg['LoginCookieRecall'] </b>boolean</dt>
<dd>
Define whether the previous login should be recalled or not in cookie
authentication mode.
<br /><br />
</dd>
<dt><b>$cfg['UseDbSearch'] </b>boolean</dt>
<dd>
Define whether the "search string inside database" is enabled or not.
<br /><br />
</dd>
<dt><b>$cfg['ShowStats'] </b>boolean</dt>
<dd>
Defines whether to display space usage and statistics about databases
and tables or not.<br />
Note that statistics requires at least MySQL 3.23.3 and that, at this
date, MySQL doesn't return such information for Berkeley DB tables.
<br /><br />
</dd>
<dt><b>$cfg['ShowBlob'] </b>boolean</dt>
<dd>
Defines whether <tt>BLOB</tt> fields are shown when browsing a table's
@@ -1291,8 +1299,89 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
<dt><b>$cfg['RepeatCells'] </b>integer</dt>
<dd>
Repeat the headers every X cells, or 0 to deactivate.
<br /><br />
Repeat the headers every X cells, or 0 to deactivate.
<br /><br />
</dd>
<dt><b>$cfg['SQP']['enable']</b> boolean</dt>
<dd>
As of phpMyAdmin 2.3.0, we now have a fully functional SQL Parser system.
It is enabled by default, as it is used to format the SQL queries.
<br />
As of 2.3.1, it will become an integral part of phpMyAdmin, as it will
analyze certain queries to improve the behavior of phpMyAdmin. But as
it is very new, and not yet heavily used, we offer you an option to
turn it off.
<br /><br />
</dd>
<dt><b>$cfg['SQP']['fmtType']</b> string [<tt>html</tt>|<tt>none</tt>]</dt>
<dd>
The main use of the new SQL Parser is to pretty-print SQL queries. By
default we use HTML to format the query, but you can disable this by
setting this varible to <tt>'none'</tt>
<br /><br />
</dd>
<dt><b>$cfg['SQP']['fmtInd']</b> float<br />
<b>$cfg['SQP']['fmtIndUnit']</b> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
<dd>
For the pretty-printing of SQL queries, under some cases the part of a
query inside a bracket is indented. By changing
<tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
<br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
specifies the units of the indent amount that you specified. This is
used via stylesheets.
<br /><br />
</dd>
<dt><b>$cfg['SQP']['fmtColor']</b> array of string tuples</dt>
<dd>
This array is used to define the colours for each type of element of
the pretty-printed SQL queries. The tuple format is<br />
<i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
If you specify an empty string for the color of a class, it is ignored
in creating the stylesheet.
You should not alter the class names, only the colour strings.<br />
<b>Class name key:</b><br />
<ul>
<li><b>comment</b> Applies to all comment sub-classes</li>
<li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
<li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
<li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
<li><b>digit</b> Applies to all digit sub-classes</li>
<li><b>digit_hex</b> Hexadecimal numbers</li>
<li><b>digit_integer</b> Integer numbers</li>
<li><b>digit_float</b> Floating point numbers</li>
<li><b>punct</b> Applies to all punctuation sub-classes</li>
<li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
<li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
<li><b>punct_listsep</b> List item seperator <tt>","</tt></li>
<li><b>punct_qualifier</b> Table/Column Qualifer <tt>"."</tt> </li>
<li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
<li><b>alpha</b> Applies to all alphabetic classes</li>
<li><b>alpha_columnType</b> Identifers matching a column type</li>
<li><b>alpha_columnAttrib</b> Identifers matching a database/table/column attribute</li>
<li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
<li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
<li><b>alpha_variable</b> Identifers matching a SQL variable <tt>"@foo"</tt></li>
<li><b>alpha_identifier</b> All other identifiers</li>
<li><b>quote</b> Applies to all quotation mark classes</li>
<li><b>quote_double</b> Double quotes <tt>"</tt></li>
<li><b>quote_single</b> Single quotes <tt>'</tt></li>
<li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
</ul><br />
</dd>
<dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
<dd>TODO
<br /><br />
</dd>
<dt><b>$cfg['SQLValidator']['username']</b> string<br />
<b>$cfg['SQLValidator']['password']</b> string</dt>
<dd>TODO
<br /><br />
</dd>
<dt><b>$cfg['ColumnTypes'] </b>array</dt>
@@ -1316,14 +1405,6 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
<br /><br />
</dd>
<dt><b>$cfg['keywords'] </b>array</dt>
<dd>
A list of keywords that is used for syntax coloring. All keywords that
are in this list will also get a new line before them.<br />
Usually you won't need to change those.
<br /><br />
</dd>
</dl>
@@ -2157,6 +2238,12 @@ $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
work with it, nor delete it.<br />
</p>
<p>
<b>[6.14] How do I set up the SQL validator?</b>
<br />
TODO
</p>
<a name="faqproject"></a>
<h3>[7. phpMyAdmin project]</h3>
<p>
@@ -2354,6 +2441,7 @@ CREDITS, in chronological order
* sync'ed different existing CVS trees with new features and bugfixes
* multi-language improvements, dynamic language selection
* current project maintainer
* many bugfixes and improvements
[lc] - Lo<4C>c Chapeaux &lt;lolo_at_phpheaven.net&gt;
* rewrote and optimized javascript, DHTML and DOM stuff
@@ -2366,7 +2454,10 @@ CREDITS, in chronological order
* database maintence controls
* table type code
* Host authentication IP Allow/Deny
* DB-based configuration
* DB-based configuration (Not completed)
* SQL parser
* SQL validator
* many bugfixes and improvements
[af] - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
* bookmarks feature
@@ -2398,6 +2489,7 @@ CREDITS, in chronological order
* XML exports
* various small features and fixes
* German language file updates
* many bugfixes and improvements
[mb] - Mike Beck &lt;mike.beck_at_ibmiller.de&gt;
* automatic joins in QBE
@@ -2425,7 +2517,7 @@ code since version 2.1.0:
- Maxime Delorme &lt;delorme.maxime at free.fr&gt; for the PDF schema output;
thanks also to Olivier Plathey for the &quot;FPDF&quot; library
(see http://www.fpdf.org/).
- Olof Edlund &lt;olof.edlund at upright.se&gt; for the SQL validator server.
And also to the following people who have contributed minor changes,
enhancements, bugfixes or support for a new language since version 2.1.0:

View File

@@ -88,10 +88,10 @@ $cfg['Servers'][$i]['table_info'] = ''; // table to describe the dis
// - leave blank for no display fields support
$cfg['Servers'][$i]['table_coords'] = ''; // table to describe the tables position for the PDF
// schema - leave blank for no PDF schema support
$cfg['Servers'][$i]['column_comments'] // table to store columncomments
= '';
// - leave blank if you don't want to use this
$cfg['Servers'][$i]['pdf_pages'] = ''; // table to describe pages of relationpdf
// - leave blank if you don't want to use this
$cfg['Servers'][$i]['column_comments'] // table to store columncomments
= ''; // - leave blank if you don't want to use this
$cfg['Servers'][$i]['AllowDeny']['order'] // Host authentication order, leave blank to not use
= '';
$cfg['Servers'][$i]['AllowDeny']['rules'] // Host authentication rules, leave blank for defaults
@@ -115,8 +115,8 @@ $cfg['Servers'][$i]['bookmarktable'] = '';
$cfg['Servers'][$i]['relation'] = '';
$cfg['Servers'][$i]['table_info'] = '';
$cfg['Servers'][$i]['table_coords'] = '';
$cfg['Servers'][$i]['column_comments'] = '';
$cfg['Servers'][$i]['pdf_pages'] = '';
$cfg['Servers'][$i]['column_comments'] = '';
$cfg['Servers'][$i]['AllowDeny']['order']
= '';
$cfg['Servers'][$i]['AllowDeny']['rules']
@@ -139,8 +139,8 @@ $cfg['Servers'][$i]['bookmarktable'] = '';
$cfg['Servers'][$i]['relation'] = '';
$cfg['Servers'][$i]['table_info'] = '';
$cfg['Servers'][$i]['table_coords'] = '';
$cfg['Servers'][$i]['column_comments'] = '';
$cfg['Servers'][$i]['pdf_pages'] = '';
$cfg['Servers'][$i]['column_comments'] = '';
$cfg['Servers'][$i]['AllowDeny']['order']
= '';
$cfg['Servers'][$i]['AllowDeny']['rules']
@@ -237,6 +237,10 @@ $cfg['ManualBaseShort'] = 'http://www.mysql.com/doc';
// Default language to use, if not browser-defined or user-defined
$cfg['DefaultLang'] = 'en-iso-8859-1';
// Force: always use this language - must be defined in
// libraries/select_lang.lib.php3
// $cfg['Lang'] = 'en-iso-8859-1';
// Default charset to use for recoding of MySQL queries, does not take
// any effect when charsets recoding is switched off by
// $cfg['AllowAnywhereRecoding'] or in language file
@@ -249,93 +253,6 @@ $cfg['DefaultCharset'] = 'iso-8859-1';
// extension and where dl() is not supported
$cfg['AllowAnywhereRecoding'] = FALSE;
// Force: always use this language - must be defined in
// libraries/select_lang.lib.php3
// $cfg['Lang'] = 'en-iso-8859-1';
// Loads language file
require('./libraries/select_lang.lib.php3');
/**
* Customization & design
*/
$cfg['LeftWidth'] = 150; // left frame width
$cfg['LeftBgColor'] = '#D0DCE0'; // background color for the left frame
$cfg['LeftPointerColor'] = '#CCFFCC'; // color of the pointer in left frame
// (blank for no pointer)
$cfg['RightBgColor'] = '#F5F5F5'; // background color for the right frame
$cfg['RightBgImage'] = ''; // path to a background image for the right frame
// (leave blank for no background image)
$cfg['Border'] = 0; // border width on tables
$cfg['ThBgcolor'] = '#D3DCE3'; // table header row colour
$cfg['BgcolorOne'] = '#CCCCCC'; // table data row colour
$cfg['BgcolorTwo'] = '#DDDDDD'; // table data row colour, alternate
$cfg['BrowsePointerColor'] = '#CCFFCC'; // color of the pointer in browse mode
// (blank for no pointer)
$cfg['BrowseMarkerColor'] = '#FFCC99'; // color of the marker (visually marks row
// by clicking on it) in browse mode
// (blank for no marker)
$cfg['TextareaCols'] = 40; // textarea size (columns) in edit mode
// (this value will be emphasized (*2) for sql
// query textareas)
$cfg['TextareaRows'] = 7; // textarea size (rows) in edit mode
$cfg['LimitChars'] = 50; // max field data length in browse mode
$cfg['ModifyDeleteAtLeft'] = TRUE; // show edit/delete links on left side of browse
// (or at the top with vertical browse)
$cfg['ModifyDeleteAtRight'] = FALSE; // show edit/delete links on right side of browse
// (or at the bottom with vertical browse)
$cfg['DefaultDisplay'] = 'horizontal'; // default display direction (horizontal|vertical)
$cfg['RepeatCells'] = 100; // repeat header names every X cells? (0 = deactivate)
/**
* SQL Query box settings
* These are the links display in all of the SQL Query boxes
*/
$cfg['SQLQuery']['Edit'] = TRUE; // Edit link to change a query
$cfg['SQLQuery']['Explain'] = TRUE; // EXPLAIN on SELECT queries
$cfg['SQLQuery']['ShowAsPHP'] = TRUE; // Wrap a query in PHP
$cfg['SQLQuery']['Validate'] = FALSE; // Validate a query (see $cfg['SQLValidator'] as well)
/**
* If you wish to use the SQL Validator service, you shoule be
* aware of the following:
* All SQL statements are stored anonymously for statistical purposes.
* Mimer SQL Validator, Copyright 2002 Upright Database Technology.
* All rights reserved.
*/
$cfg['SQLValidator']['use'] = FALSE; // Make the SQL Validator available
$cfg['SQLValidator']['username'] = ''; // If you have a custom username, specify it here (defaults to anonymous)
$cfg['SQLValidator']['password'] = ''; // Password for username
$cfg['SQLValidator']['DisplayCopyright'] = TRUE; // It is possible to strip the copyright, but strongly discouraged
/**
* SQL Parser Settings
*/
$cfg['SQP']['enable'] = TRUE; // Totally turn off the SQL Parser (not recommended)
$cfg['SQP']['fmtType'] = 'html'; // Pretty-printing style to use on queries (html, none)
$cfg['SQP']['fmtInd'] = '1'; // Amount to indent each level (floats ok)
$cfg['SQP']['fmtIndUnit'] = 'em'; // Units for indenting each level (CSS Types - {em,px,pt})
$cfg['SQP']['fmtColor'] = array( // Syntax colouring data
'comment' => '#808000',
'digit' => '',
'digit_hex' => 'teal',
'digit_integer' => 'teal',
'digit_float' => 'aqua',
'punct' => 'fuchsia',
'alpha' => '',
'alpha_columnType' => '#FF9900',
'alpha_columnAttrib' => '#0000FF',
'alpha_reservedWord' => '#990099',
'alpha_functionName' => '#FF0000',
'alpha_identifier' => 'black',
'alpha_variable' => '#800000',
'quote' => '#008000',
'quote_double' => '',
'quote_single' => '',
'quote_backtick' => ''
);
/**
* Available charsets for MySQL conversion. currently contains all which could
* be found in lang/* files and few more.
@@ -375,6 +292,91 @@ $cfg['AvailableCharsets'] = array(
'SHIFT_JIS'
);
// Loads language file
require('./libraries/select_lang.lib.php3');
/**
* Customization & design
*/
$cfg['LeftWidth'] = 150; // left frame width
$cfg['LeftBgColor'] = '#D0DCE0'; // background color for the left frame
$cfg['RightBgColor'] = '#F5F5F5'; // background color for the right frame
$cfg['RightBgImage'] = ''; // path to a background image for the right frame
// (leave blank for no background image)
$cfg['LeftPointerColor'] = '#CCFFCC'; // color of the pointer in left frame
// (blank for no pointer)
$cfg['Border'] = 0; // border width on tables
$cfg['ThBgcolor'] = '#D3DCE3'; // table header row colour
$cfg['BgcolorOne'] = '#CCCCCC'; // table data row colour
$cfg['BgcolorTwo'] = '#DDDDDD'; // table data row colour, alternate
$cfg['BrowsePointerColor'] = '#CCFFCC'; // color of the pointer in browse mode
// (blank for no pointer)
$cfg['BrowseMarkerColor'] = '#FFCC99'; // color of the marker (visually marks row
// by clicking on it) in browse mode
// (blank for no marker)
$cfg['TextareaCols'] = 40; // textarea size (columns) in edit mode
// (this value will be emphasized (*2) for sql
// query textareas)
$cfg['TextareaRows'] = 7; // textarea size (rows) in edit mode
$cfg['LimitChars'] = 50; // max field data length in browse mode
$cfg['ModifyDeleteAtLeft'] = TRUE; // show edit/delete links on left side of browse
// (or at the top with vertical browse)
$cfg['ModifyDeleteAtRight'] = FALSE; // show edit/delete links on right side of browse
// (or at the bottom with vertical browse)
$cfg['DefaultDisplay'] = 'horizontal'; // default display direction (horizontal|vertical)
$cfg['RepeatCells'] = 100; // repeat header names every X cells? (0 = deactivate)
/**
* SQL Query box settings
* These are the links display in all of the SQL Query boxes
*/
$cfg['SQLQuery']['Edit'] = TRUE; // Edit link to change a query
$cfg['SQLQuery']['Explain'] = TRUE; // EXPLAIN on SELECT queries
$cfg['SQLQuery']['ShowAsPHP'] = TRUE; // Wrap a query in PHP
$cfg['SQLQuery']['Validate'] = FALSE; // Validate a query (see $cfg['SQLValidator'] as well)
/**
* SQL Parser Settings
*/
$cfg['SQP']['enable'] = TRUE; // Totally turn off the SQL Parser (not recommended)
$cfg['SQP']['fmtType'] = 'html'; // Pretty-printing style to use on queries (html, none)
$cfg['SQP']['fmtInd'] = '1'; // Amount to indent each level (floats ok)
$cfg['SQP']['fmtIndUnit'] = 'em'; // Units for indenting each level (CSS Types - {em,px,pt})
$cfg['SQP']['fmtColor'] = array( // Syntax colouring data
'comment' => '#808000',
'comment_mysql' => '',
'comment_ansi' => '',
'comment_c' => '',
'digit' => '',
'digit_hex' => 'teal',
'digit_integer' => 'teal',
'digit_float' => 'aqua',
'punct' => 'fuchsia',
'alpha' => '',
'alpha_columnType' => '#FF9900',
'alpha_columnAttrib' => '#0000FF',
'alpha_reservedWord' => '#990099',
'alpha_functionName' => '#FF0000',
'alpha_identifier' => 'black',
'alpha_variable' => '#800000',
'quote' => '#008000',
'quote_double' => '',
'quote_single' => '',
'quote_backtick' => ''
);
/**
* If you wish to use the SQL Validator service, you shoule be
* aware of the following:
* All SQL statements are stored anonymously for statistical purposes.
* Mimer SQL Validator, Copyright 2002 Upright Database Technology.
* All rights reserved.
*/
$cfg['SQLValidator']['use'] = FALSE; // Make the SQL Validator available
$cfg['SQLValidator']['username'] = ''; // If you have a custom username, specify it here (defaults to anonymous)
$cfg['SQLValidator']['password'] = ''; // Password for username
/**
* MySQL settings