kennethreitz/records
1
0
Fork 0
mirror of https://github.com/kennethreitz/records.git synced 2026-06-05 14:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.rst

Browse Source
This commit is contained in:
Kenneth Reitz
2016-02-11 19:56:16 -05:00
parent 47b776c36d
commit f1b2266bb5
1 changed files with 23 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+23 -24
View File
@@ -121,38 +121,37 @@ Of course, the recommended installation method is pip::
-------------------
As an added bonus, a `records` command-line tool is also included in
this distribution. Here's the usage, so you get an idea of it:
this distribution. Here's the usage, so you get an idea of it::
```
Records: SQL for Humans™
A Kenneth Reitz project.
Records: SQL for Humans™
A Kenneth Reitz project.
Usage:
records <query> <format> [-i] [--params <params>...] [--url=<url>]
records (-h | --help)
Usage:
records <query> <format> [-i] [--params <params>...] [--url=<url>]
records (-h | --help)
Options:
-h --help Show this screen.
--url=<url> The database URL to use. Defaults to $DATABASE_URL.
--params Prameterized query. Subsequent arguments are treated as
parameters to the query.
-i --interactive An interactive interpreter.
Options:
-h --help Show this screen.
--url=<url> The database URL to use. Defaults to $DATABASE_URL.
--params Prameterized query. Subsequent arguments are treated as
parameters to the query.
-i --interactive An interactive interpreter.
Supported Formats:
csv, tsv, json, yaml, html, xls, xlsx, dbf, latex, ods
Supported Formats:
csv, tsv, json, yaml, html, xls, xlsx, dbf, latex, ods
Note: xls, xlsx, dbf, and ods formats are binary, and should only be
used with redirected output e.g. '$ records sql xls > sql.xls'.
Notes:
- While you may specify a Postgres connection string with --url, records
will automatically default to the value of $DATABASE_URL, if available.
- Query is intended to be the path of a SQL file, however a query string
can be provided instead. Use this feature discernfully; it's dangerous.
- Records is intended for report-style exports of database queries, and
has not yet been optimized for extremely large data dumps.
- Interactive mode is experimental and may be removed at any time.
Feedback, as always, is much appreciated! --me@kennethreitz.org
Notes:
- While you may specify a Postgres connection string with --url, records
will automatically default to the value of $DATABASE_URL, if available.
- Query is intended to be the path of a SQL file, however a query string
can be provided instead. Use this feature discernfully; it's dangerous.
- Records is intended for report-style exports of database queries, and
has not yet been optimized for extremely large data dumps.
- Interactive mode is experimental and may be removed at any time.
Feedback, as always, is much appreciated! --me@kennethreitz.org
Cake:
✨ 🍰 ✨