changeset 373:2fd766784ff2

semi-automate documentation upload
author catherine@DellZilla
date Tue, 11 Aug 2009 10:14:27 -0400
parents 832ec6607b22
children 05758f4bcac1
files docs/refresh.bash docs/source/capabilities.rst
diffstat 2 files changed, 21 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/docs/refresh.bash	Sat Aug 08 00:31:05 2009 -0400
+++ b/docs/refresh.bash	Tue Aug 11 10:14:27 2009 -0400
@@ -1,2 +1,7 @@
 sphinx-build -b html source build
-scp -r build catherine@$tummy:/var/www/sqlpython
\ No newline at end of file
+#scp -r build catherine@$tummy:/var/www/sqlpython
+cd build
+zip -r sqlpython_docs *
+mv sqlpython_docs.zip ..
+cd ..
+echo "Upload sqlpython_docs.zip to http://pypi.python.org/pypi/sqlpython"
--- a/docs/source/capabilities.rst	Sat Aug 08 00:31:05 2009 -0400
+++ b/docs/source/capabilities.rst	Tue Aug 11 10:14:27 2009 -0400
@@ -477,6 +477,21 @@
 top, top9i
   Displays active sessions
 
+BLOB display
+============
+
+(Oracle only, for now)
+
+When a SELECT query returns BLOB columns, most SQL tools simply cannot 
+display the results.  Sqlpython, however, will create
+a local file for each BLOB returned (up to the parameter `bloblimit`),
+and return the filepaths of the new files in the query results.  In a 
+tool like the GNOME terminal, these filepaths work as right-clickable
+links that can open the files.
+
+When the \\h terminator is used to generate HTML table output, if the 
+BLOBs are images, they will be embedded as images in the generated
+table.