Mercurial > sqlpython
changeset 283:80484bc60bdd
still needs refs
| author | catherine@dellzilla |
|---|---|
| date | Thu, 19 Mar 2009 17:30:53 -0400 |
| parents | 4eef08cfaf25 |
| children | ad20675a17f7 |
| files | docs/source/capabilities.rst docs/source/intro.rst |
| diffstat | 2 files changed, 66 insertions(+), 52 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/source/capabilities.rst Thu Mar 19 16:56:36 2009 -0400 +++ b/docs/source/capabilities.rst Thu Mar 19 17:30:53 2009 -0400 @@ -84,33 +84,35 @@ Examples:: + Need examples!!!! + Special output formats ====================== By replacing the `;` that terminates a SELECT statement with a backslash-character sequence, you can get output in a number of useful formats. The `terminators` -command lists them, for your convenience:: +command lists them, for your convenience. -=== ======================== ================================ - Especially useful for -=== ======================== ================================ -; standard Oracle format -\c CSV (with headings) sending to spreadsheets -\C CSV (no headings) -\g list wide output with linewraps -\G aligned list -\h HTML table web reports -\i INSERT statements copying to other instances -\j JSON -\s CSV (with headings) -\S CSV (no headings) -\t transposed "narrow" tables like v$database -\x XML -\l line plot, with markers -\L scatter plot (no lines) -\b bar graph -\p pie chart -=== ======================== ================================ +========== ======================== ================================ +terminator format Useful for +========== ======================== ================================ +; standard Oracle format +\\c CSV (with headings) sending to spreadsheets +\\C CSV (no headings) +\\g list wide output with linewraps +\\G aligned list +\\h HTML table web reports +\\i INSERT statements copying to other instances +\\j JSON +\\s CSV (with headings) +\\S CSV (no headings) +\\t transposed "narrow" tables like v$database +\\x XML +\\l line plot, with markers +\\L scatter plot (no lines) +\\b bar graph +\\p pie chart +========== ======================== ================================ Most of these output formats are even more useful when combined with special output destinations. For example, `SELECT * FROM party\h > /var/www/party_report.html` @@ -144,7 +146,7 @@ that fits into a SELECT statement (WHERE, ORDER BY, etc.) grep {grep {target} {table} [{table2,...}] - Equivalent to SELECT * FROM {table} WHERE *any column* LIKE '%{target}%' + Equivalent to SELECT * FROM {table} WHERE *any column* LIKE '%{target}%'. Useful when you don't know, don't remember, or don't care which column a value may be found in. @@ -156,14 +158,17 @@ Lists all tables or columns whose names contain {target}. More convenient than querying user_tab_columns/all_tab_columns or user_tables/all_tables. Options:: + -a Find all objects (not just my own) PostgreSQL-like shortcuts ========================= ------ ------------------ -z y ------ ------------------ +psql, the command-line client for the open-source database `PostgreSQL <http://www.postgresql.org/>`_ uses a number +of backslash-character sequences as convenient shortcuts. sqlpython steals many of +them. + +===== =================== \\c connect \\d desc \\e edit @@ -181,7 +186,7 @@ \\dv _dir_views \\di _dir_indexes \\? help psql ------ ------------------ +===== =================== PL/SQL source code ================== @@ -203,6 +208,7 @@ Lists all PL/SQL objects whose source code contains the {target} string. Always case-insensitive. Options:: + -a Search all PL/SQL objects (not just my own) @@ -369,32 +375,36 @@ Several parameters control the behavior of sqlpython itself. -===================== ================================================== =============== - default -===================== ================================================== =============== -autobind When True, single-row queries automatically `bind` False -commit_on_exit Automatically commits work at end of session True -continuation_prompt Prompt for second line and onward of long statement > -default_file_name The file opened by `edit`, if not specified afiedt.buf -echo Echo command entered before executing False -editor Text editor invoked by `edit`. varies -heading Print column names True -maxfetch Maximum number of rows to return from any query 1000 -maxtselctrows Maximum # of rows from a tselect or \\n query 10 -prompt Probably unwise to change user@instance> -scan Interpret & as indicating substitution variables True -serveroutput Print DBMS_OUTPUT.PUT_LINE results True -sql_echo Print text of "behind-the-scenes" queries False -timeout In seconds 30 -timing Print time for each command to execute False -wildsql Accept *, %, #, and ! in column names False -===================== ================================================== =============== +===================== =================================================== =============== +parameter effect default +===================== =================================================== =============== +autobind When True, single-row queries automatically `bind` False +commit_on_exit Automatically commits work at end of session True +continuation_prompt Prompt for second line and onward of long statement > +default_file_name The file opened by `edit`, if not specified afiedt.buf +echo Echo command entered before executing False +editor Text editor invoked by `edit`. varies +heading Print column names True +maxfetch Maximum number of rows to return from any query 1000 +maxtselctrows Maximum # of rows from a tselect or \\n query 10 +prompt Probably unwise to change user@instance> +scan Interpret & as indicating substitution variables True +serveroutput Print DBMS_OUTPUT.PUT_LINE results True +sql_echo Print text of "behind-the-scenes" queries False +timeout In seconds 30 +timing Print time for each command to execute False +wildsql Accept *, %, #, and ! in column names False +===================== =================================================== =============== The user can change these with the `set {paramname} {new-value}` statement. -The True/False parameters accept new -values permissively, recognizing "True", "False", "T", "F", "yes", "no", "on", "off"... +The True/False parameters accept new values permissively, recognizing "True", "False", +"T", "F", "yes", "no", "on", "off", etc. -`set` and `show` both list the current values of the sqlpython parameters. +`set` and `show` both list the current values of the sqlpython parameters. They +also recognize any abbreviated parameter name, so long as it is long enough to be +unique. That is, `show maxf` is recognized as `show maxfetch`, but `show max` is +too short to distinguish between `maxfetch` and `maxtselctrows`. + `show parameter {param}` shows current Oracle parameters (from v$parameter), as it does in SQL\*Plus.
--- a/docs/source/intro.rst Thu Mar 19 16:56:36 2009 -0400 +++ b/docs/source/intro.rst Thu Mar 19 17:30:53 2009 -0400 @@ -5,10 +5,14 @@ SQL\*Plus. For the most part, it can be used the same way SQL\*Plus would be used; this documentation focuses on the places where SQLPython differs. -SQLPython was created by `Luca Canali <http://canali.web.cern.ch/canali/>_` at CERN. Most new development -has been done by `Catherine Devlin <http://catherinedevlin.blogspot.com/>_`. +SQLPython was created by `Luca Canali <http://canali.web.cern.ch/canali/>`_ at CERN. Most new development +has been done by `Catherine Devlin <http://catherinedevlin.blogspot.com/>`_. -SQLPython is based on the Python standard library's cmd module, and on an extension to it called cmd2. +SQLPython is based on the Python standard library's +`cmd <http://docs.python.org/library/cmd.html#module-cmd>`_ module, and on an extension +to it called `cmd2 <http://pypi.python.org/pypi/cmd2>`_. SQLPython also draws considerable +inspiration from two Perl-based open-source SQL clients, +`Senora <http://senora.sourceforge.net/>`_ and `YASQL <http://sourceforge.net/projects/yasql>`_. SQLPython is currently only compatible with Oracle databases. Expanding it to other RDBMS is a dream for "one fine day". Call it "SQLPython 3000". \ No newline at end of file