Mercurial > sqlpython

comparison docs/source/intro.rst @ 329:3efffbf7481f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fixed bug in assigning 0, null to bind vars
author Catherine Devlin <catherine.devlin@gmail.com>
date Mon, 06 Apr 2009 14:45:05 -0400
parents 22fc9a350eaa
children 26f60d5910a0
comparison
equal deleted inserted replaced
325:8721372d81be 329:3efffbf7481f
3 3
4 * Original project homepage: https://twiki.cern.ch/twiki/bin/view/PSSGroup/SqlPython 4 * Original project homepage: https://twiki.cern.ch/twiki/bin/view/PSSGroup/SqlPython
5 * PyPI: http://pypi.python.org/pypi/sqlpython 5 * PyPI: http://pypi.python.org/pypi/sqlpython
6 * News: http://catherinedevlin.blogspot.com/search/label/sqlpython 6 * News: http://catherinedevlin.blogspot.com/search/label/sqlpython
7 * Current docs: http://packages.python.org/sqlpython/ 7 * Current docs: http://packages.python.org/sqlpython/
8 * Mailing list: http://groups.google.com/group/sqlpython
8 9
9 SQLPython is a command-line interface to Oracle databases. It is intended as an alternative to Oracle's 10 SQLPython is a command-line interface to Oracle databases. It is intended as an alternative to Oracle's
10 SQL\*Plus. For the most part, it can be used the same way SQL\*Plus would be used; this documentation 11 SQL\*Plus. For the most part, it can be used the same way SQL\*Plus would be used; this documentation
11 focuses on the places where SQLPython differs. 12 focuses on the places where SQLPython differs.
12 13
13 SQLPython was created by `Luca Canali <http://canali.web.cern.ch/canali/>`_ at CERN. Most new development 14 License
14 has been done by `Catherine Devlin <http://catherinedevlin.blogspot.com/>`_. The development trunk (very unstable) is at `assembla <https://www.assembla.com/wiki/show/sqlpython>`_; you can install the trunk on your machine with:: 15 -------
16
17 sqlpython is free and open-source software. Its use is governed by the
18 `MIT License <http://www.opensource.org/licenses/mit-license.php>`_.
19
20 Authorship
21 ----------
22
23 SQLPython was created by `Luca Canali <http://canali.web.cern.ch/canali/>`_ at CERN. Most recent
24 development has been done by `Catherine Devlin <http://catherinedevlin.blogspot.com/>`_. A group
25 of additional sqlpython contributors has formed at
26 `Google Groups <http://groups.google.com/group/sqlpython>`_.
27
28 Installation
29 ------------
30
31 If `python-setuptools <http://pypi.python.org/pypi/setuptools>`_ is present on your machine, you
32 can easily install the latest release of sqlpython by issuing from a command prompt::
33
34 easy_install sqlpython
35
36 The development trunk
37 (very unstable) is at `assembla <https://www.assembla.com/wiki/show/sqlpython>`_;
38 you can install the trunk on your machine with::
15 39
16 hg clone http://hg.assembla.com/python-cmd2 cmd2 40 hg clone http://hg.assembla.com/python-cmd2 cmd2
17 cd cmd2 41 cd cmd2
18 python setup.py develop 42 python setup.py develop
19 43
44 cd ..
20 hg clone http://hg.assembla.com/sqlpython sqlpython 45 hg clone http://hg.assembla.com/sqlpython sqlpython
21 cd sqlpython 46 cd sqlpython
22 python setup.py develop 47 python setup.py develop
23 48
24 Using `hg pull`, `hg update` subsequently will update from the current trunk. 49 Using `hg pull`, `hg update` subsequently will update from the current trunk.
50
51 You may also install from the trunk with easy_install::
52
53 easy_install
54
55 Running
56 -------
57
58 sqlpython [username[/password][@SID]] ["SQL command 1", "@script.sql", "SQL command 2..."]
59
60 Database connections can also be specified with URL syntax or with Oracle Easy Connect::
61
62 oracle://username:password@SID
63
64 oracle://username:password@hostname:port/dbname
65
66 oracle://username:password@hostname:port/dbname
67
68 SID represents an entry from the `tnsnames.ora` file.
69
70 Once connected, most familiar SQL\*Plus commands can be used. Type `help` for additional
71 information.
72
73 Bugs
74 ----
75
76 Please report bugs at http://trac-hg.assembla.com/sqlpython or to catherine.devlin@gmail.com.
77
78 Origins
79 -------
25 80
26 SQLPython is based on the Python standard library's 81 SQLPython is based on the Python standard library's
27 `cmd <http://docs.python.org/library/cmd.html#module-cmd>`_ module, and on an extension 82 `cmd <http://docs.python.org/library/cmd.html#module-cmd>`_ module, and on an extension
28 to it called `cmd2 <http://pypi.python.org/pypi/cmd2>`_. SQLPython also draws considerable 83 to it called `cmd2 <http://pypi.python.org/pypi/cmd2>`_. SQLPython also draws considerable
29 inspiration from two Perl-based open-source SQL clients, 84 inspiration from two Perl-based open-source SQL clients,
30 `Senora <http://senora.sourceforge.net/>`_ and `YASQL <http://sourceforge.net/projects/yasql>`_. 85 `Senora <http://senora.sourceforge.net/>`_ and `YASQL <http://sourceforge.net/projects/yasql>`_.
31 86
32 SQLPython is currently only compatible with Oracle databases. Expanding it to other RDBMS is a dream 87 Non-Oracle RDBMS
33 for "one fine day". Call it "SQLPython 3000". 88 ----------------
89
90 As of sqlpython 1.6.4, preliminary work has begun to adapt sqlpython to non-Oracle databases.
91 You may use it to run queries against postgreSQL, MySQL, etc., but data-dictionary access
92 commands (`ls`, `grep`, `refs`, etc.) will generate errors. Connection to non-Oracle databases
93 is currently only possible via URL connection strings.
94