Improved documentation for all db modules.
This commit is contained in:
parent
b0aaeaa436
commit
6ca9e5cbcc
4 changed files with 134 additions and 6 deletions
|
|
@ -10,7 +10,48 @@
|
|||
## A higher level `SQLite`:idx: database wrapper. This interface
|
||||
## is implemented for other databases too.
|
||||
##
|
||||
## Example:
|
||||
## See also: `db_odbc <db_odbc.html>`_, `db_postgres <db_postgres.html>`_,
|
||||
## `db_mysql <db_mysql.html>`_.
|
||||
##
|
||||
## Parameter substitution
|
||||
## ----------------------
|
||||
##
|
||||
## All ``db_*`` modules support the same form of parameter substitution.
|
||||
## That is, using the ``?`` (question mark) to signify the place where a
|
||||
## value should be placed. For example:
|
||||
##
|
||||
## .. code-block:: Nim
|
||||
## sql"INSERT INTO myTable (colA, colB, colC) VALUES (?, ?, ?)"
|
||||
##
|
||||
## Examples
|
||||
## --------
|
||||
##
|
||||
## Opening a connection to a database
|
||||
## ==================================
|
||||
##
|
||||
## .. code-block:: Nim
|
||||
## import db_sqlite
|
||||
## let db = open("localhost", "user", "password", "dbname")
|
||||
## db.close()
|
||||
##
|
||||
## Creating a table
|
||||
## ================
|
||||
##
|
||||
## .. code-block:: Nim
|
||||
## db.exec(sql"DROP TABLE IF EXISTS myTable")
|
||||
## db.exec(sql("""CREATE TABLE myTable (
|
||||
## id integer,
|
||||
## name varchar(50) not null)"""))
|
||||
##
|
||||
## Inserting data
|
||||
## ==============
|
||||
##
|
||||
## .. code-block:: Nim
|
||||
## db.exec(sql"INSERT INTO myTable (id, name) VALUES (0, ?)",
|
||||
## "Jack")
|
||||
##
|
||||
## Larger example
|
||||
## ==============
|
||||
##
|
||||
## .. code-block:: nim
|
||||
##
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue