Flags:¶

-p

Print current connection parameters and exit

-g

Print current connection parameters using shell style and exit [deprecated]
This flag is deprecated and will be removed in a future release. Use format=shell instead.

-c

Check connection parameters, set if uninitialized, and exit

-d

Set from default settings and exit
Overwrite current settings if already initialized

--help

Print usage summary

--verbose

Verbose module output

--quiet

Quiet module output

--ui

Force launching GUI dialog

Parameters:¶

driver=name

Name of database driver
Options: dbf, mysql, odbc, ogr, pg, sqlite
Default: sqlite

database=name

Name of database
Default: $GISDBASE/$LOCATION_NAME/$MAPSET/sqlite/sqlite.db

schema=name

Database schema
Do not use this option if schemas are not supported by driver/database server

group=string

Default group of database users to which select privilege is granted

format=name [required]

Output format
Options: plain, shell, json
Default: plain
plain: Plain text output
shell: shell script style output
json: JSON (JavaScript Object Notation)

SQLite (default backend)¶

Local storage:

db.connect -d
db.connect -p
db.tables -p

The SQLite database file is created automatically when used the first time.

See SQLite database driver for details.

PostgreSQL (local connection)¶

Local storage, database tables stored in database "mydb" (may require the use of db.login):

db.connect driver=pg database=mydb
db.login user=myname pass=secret
db.connect -p
db.tables -p

See PostgreSQL database driver for details.

PostgreSQL (network connection)¶

Network storage, database tables stored in database "mydb" (may require the use of db.login):

db.connect driver=pg database=mydb
db.login user=myname pass=secret host=myserver.com port=6666
db.connect -p
db.tables -p

See PostgreSQL database driver for details.

MySQL (local connection)¶

Local storage, database tables stored in database "mydb" (may require the use of db.login):

db.connect driver=mysql database=mydb
db.login user=myname pass=secret
db.connect -p
db.tables -p

See MySQL database driver for details.

MySQL (network connection)¶

Network storage, database tables stored in database "mydb" (may require the use of db.login):

db.connect driver=mysql database=mydb
db.login user=myname pass=secret host=myserver.com
db.connect -p
db.tables -p

See MySQL database driver for details.

ODBC¶

Network storage, database tables stored in database "mydb" (may require the use of db.login):

db.connect driver=odbc database=mydb
db.login user=myname pass=secret
db.connect -p
db.tables -p

See ODBC database driver for details.

DBF (local, not recommended)¶

Local storage (the dbf/ subdirectory in the mapset must exist or must be created by the user):

db.connect driver=dbf database=’$GISDBASE/$LOCATION_NAME/$MAPSET/dbf/’
db.tables -p

See DBF database driver for details.