Skip to content

db.createdb

Creates an empty database.

db.createdb driver=name database=name [--verbose] [--quiet] [--qq] [--ui]

Example:

db.createdb driver=sqlite database=name

grass.script.run_command("db.createdb", driver="sqlite", database, verbose=None, quiet=None, superquiet=None)

Example:

gs.run_command("db.createdb", driver="sqlite", database="name")

grass.tools.Tools.db_createdb(driver="sqlite", database, verbose=None, quiet=None, superquiet=None)

Example:

tools = Tools()
tools.db_createdb(driver="sqlite", database="name")

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

Parameters

driver=name [required]
    Name of database driver
    Allowed values: dbf, odbc, ogr, pg, sqlite
    Default: sqlite
database=name [required]
    Name of database
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

driver : str, required
    Name of database driver
    Used as: input, dbdriver, name
    Allowed values: dbf, odbc, ogr, pg, sqlite
    Default: sqlite
database : str, required
    Name of database
    Used as: input, dbname, name
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

driver : str, required
    Name of database driver
    Used as: input, dbdriver, name
    Allowed values: dbf, odbc, ogr, pg, sqlite
    Default: sqlite
database : str, required
    Name of database
    Used as: input, dbname, name
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.

DESCRIPTION

db.createdb allows the user to create a new empty database through different drivers. A working database connection needs to be established, see db.login.

Currently only SQLite and PostgreSQL database drivers are supported.

EXAMPLES

Create a new SQLite file-based database

Note that the standard GRASS SQLite database is by default generated in the user's current mapset. This example shows an out-of-mapset database file creation:

db.createdb driver=sqlite database=/opt/sqlite.db

Create a new PostgreSQL database

Create a new PostgreSQL database (after the PostgreSQL connection got established through the pg driver):

db.createdb driver=pg database=grassdb

Create a new PostgreSQL database (after the PostgreSQL connection got established through the odbc driver):

db.createdb driver=odbc database=grassdb

TODO

Support other database drivers, too.

SEE ALSO

db.columns, db.connect, db.describe, db.drivers, db.dropdb, db.droptable, db.execute, db.login, db.tables

GRASS SQL interface

AUTHORS

Radim Blazek, ITC-Irst, Trento, Italy
SQLite and PostgreSQL support by Martin Landa, Czech Technical University in Prague, Czech Republic

SOURCE CODE

Available at: db.createdb source code (history)
Latest change: Friday Aug 08 09:39:19 2025 in commit ed72c71