Examples¶
The following examples use a SQLite database containing:
CREATE TABLE users (
name text,
email text
);
INSERT INTO users (name, email) VALUES ('John', 'john@example.com');
INSERT INTO users (name, email) VALUES ('Jane', 'jane@example.com');
INSERT INTO users (name, email) VALUES ('Bobby', 'bobby@example.com');
INSERT INTO users (name, email) VALUES ('Suzy', 'suzy@example.com');
Local Connection String¶
Use the connection_string
option to specify the database to be
used for a single query.
.. sqltable:: List of Users
:connection_string: sqlite:////tmp/sampledata.db
select name as 'Name', email as 'E-mail' from users
order by Name asc
produces this table:
Name |
|
---|---|
Bobby |
bobby@example.com |
Jane |
jane@example.com |
John |
john@example.com |
Suzy |
suzy@example.com |
Missing Connection String¶
Leaving out the connection_string
option produces an error:
.. sqltable:: List of Users
select name as 'Name', email as 'E-mail' from users
order by Name asc
results in
$ sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v1.1.2
Initializing SQLTable
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
Connecting to sqlite:///sampledata.db
Running query u"select name as 'Name', email as 'E-mail' from users\norder by Name asc"
.../docs/example.rst:45: ERROR: No connection_string or sqltable_connection_string was specified for sqltable