diff docs/source/capabilities.rst @ 247:f0f293d83337

begin docs
author catherine@dellzilla
date Wed, 04 Mar 2009 17:44:29 -0500
parents
children 3c5fa8ed4f8b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/source/capabilities.rst	Wed Mar 04 17:44:29 2009 -0500
@@ -0,0 +1,54 @@
+SQLPython's extra capabilities
+==============================
+
+For the most part, SQLPython simply duplicates SQL\*Plus's capabilites.
+
+UNIX-like commands
+==================
+
+ls
+   Lists objects from the data dictionaries.  There are implied wildcards at the beginning and
+   end
+
+cat
+   Shorthand for "SELECT * FROM"
+
+PostgreSQL-like shortcuts
+=========================
+
+----- ------------------
+z     y
+----- ------------------
+\\c   connect
+\\d   desc
+\\e   edit
+\\g   run
+\\h   help
+\\i   load
+\\o   spool
+\\p   list
+\\q   quit
+\\w   save
+\\db  _dir_tablespaces
+\\dd  comments
+\\dn  _dir_schemas
+\\dt  _dir_tables
+\\dv  _dir_views
+\\di  _dir_indexes
+\\?   help psql
+----- ------------------
+
+Wild SQL
+========
+
+Wild SQL is a nonstandard SQL feature that must be enabled with `set wildsql on`.  When it is
+enabled, column names in a SELECT statement do not need to be explicitly typed.  
+
+* % or \* as wildcards::
+
+  SELECT d* FROM v$database;
+
+  SELECT 
+
+Wild SQL can only be used in the primary column list of straightforward SELECT statements, 
+not in subqueries, `UNION`ed queries, etc.
\ No newline at end of file