db.test

Test database driver, database must exist and set by db.connect.

Command linePython (grass.tools)Python (grass.script)

db.test test=string [--verbose] [--quiet] [--qq] [--ui]

Example:

db.test test=test1

grass.tools.Tools.db_test(test, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.db_test(test="test1")

This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.

grass.script.run_command("db.test", test, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("db.test", test="test1")

Parameters

Command linePython (grass.tools)Python (grass.script)

test=string [required]
    Test name
    Allowed values: test1
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

test : str, required
    Test name
    Allowed values: test1
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

Returns:

result : grass.tools.support.ToolResult | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None will be returned.

Raises:

grass.tools.ToolError: When the tool ended with an error.

test : str, required
    Test name
    Allowed values: test1
verbose : bool, optional
    Verbose module output
    Default: None
quiet : bool, optional
    Quiet module output
    Default: None
superquiet : bool, optional
    Very quiet module output
    Default: None

DESCRIPTION

db.test tests database driver and database server running set of SQL queries. Database must exist and connection must be set by db.connect.

EXAMPLE

Test current SQL backend driver:

db.connect -p
db.test test=test1

SEE ALSO

GRASS SQL interface, db.connect, db.describe, db.drivers

AUTHOR

Radim Blazek

SOURCE CODE

Available at: db.test source code (history)
Latest change: Friday Oct 10 10:16:04 2025 in commit 85fa0b4