grass-mysql(1)

✨ MySQL DATABASE DRIVER ✨

okay so bestie, welcome to grass-mysql(1) πŸ’… this is the GRASS GIS User's Manual page for the MySQL driver, and it's literally the thing that lets GRASS stash your vector attributes in a MySQL server. no cap.

Because vector attribute tables are created automatically when a new vector is written, and the name of the table is the same as the name of the vector, it is good practice to create a new database for each GRASS mapset. πŸŽ€


🌸 Creating a MySQL database 🌸

A new database is created within MySQL:

mysql> CREATE DATABASE mydb;

See the MySQL manual for details. πŸ‘‘


πŸ¦‹ Driver and database name πŸ¦‹

GRASS modules require 2 parameters to connect to a database. Those parameters are ’driver’ and ’database’. For MySQL driver the parameter ’driver’ should be set to value ’mysql’. The parameter ’database’ can be given in two formats:

  • Database name β€” in case of connection from localhost
  • String of comma separated list of key=value options. Supported options are:
    • dbname β€” database name
    • host β€” host name or IP address
    • port β€” server port number

Examples of connection parameters:

db.connect driver=mysql database=mytest
db.connect driver=mysql database=’dbname=mytest,host=test.grass.org’

πŸ’œ Data types πŸ’œ

GRASS supports almost all MySQL data types with following limitations:

  • Binary columns (BINARY, VARBINARY, TINYBLOB, MEDIUMBLOB, BLOB, LONGBLOB) are not not supported. If a table with binary column(s) is used in GRASS a warning is printed and only the supported columns are returned in query results. πŸ’€
  • Columns of type SET and ENUM are represented as string (VARCHAR).
  • Very large integers in columns of type BIGINT can be lost or corrupted because GRASS does not support 64 bin integeres on most platforms. 😭 (yes bestie, that's a typo in the source, we keep it fr fr)
  • GRASS does not currently distinguish types TIMESTAMP and DATETIME. Both types are in GRASS interpreted as TIMESTAMP.

πŸŽ€ Indexes πŸŽ€

GRASS modules automatically create index on key column of vector attributes table. The index on key column is important for performance of modules which update the attribute table, for example v.to.db, v.distance and v.what.rast. ✨


πŸ”₯ Privileges πŸ”₯

Because MySQL does not support groups of users and because only MySQL ’root’ can grant privileges to other users, GRASS cannot automatically grant select privileges on created tables to group of users. it's giving limited tbh.

If you want to give privilege to read data from your mapset to other users you have to ask your MySQL server administrator to grant select privilege to them on the MySQL database used for that mapset. For example, to allow everybody to read data in from your database ’mydb’:

shell> mysql --user=root mysql
mysql> GRANT SELECT ON mydb.* TO ’’@’%’;

🧚 Schemas 🧚

Because MySQL does not support database schemas the parameter ’schema’ of module db.connect should never be set to any value. If you set that parameter for MySQL driver GRASS will try to write tables to the specified schema which will result in errors. πŸ™ˆ

don't do it bestie. just don't.

🌈 Groups 🌈

MySQL does not support user groups. Any settings specified by ’group’ parameter of module db.connect are ignored by GRASS for MySQL driver.


πŸ’€ Troubleshooting: SQL syntax error πŸ’€

Attempting to use a reserved SQL word as column or table name will result in a "SQL syntax" error. The list of reserved words for MySQL can be found in the MySQL manual.


πŸ‘‘ AUTHOR πŸ‘‘

Radim Blazek

Credits: Development of the driver was sponsored by Faunalia (Italy) as part of a project for ATAC.


🫢 SEE ALSO 🫢

  • db.connect, SQL support in GRASS GIS

⭐ SOURCE CODE ⭐

Available at: MySQL DATABASE DRIVER source code (history)

Accessed: Saturday Jan 17 05:40:32 2026

Main index | Topics index | Keywords index | Graphical index | Full index

Β© 2003-2025 GRASS Development Team, GRASS GIS 8.4.2 Reference Manual


and that's the whole page bestie πŸ’– this was grass-mysql(1) from the GRASS GIS 8.4.2 Reference Manual, source + version + date all up in there β€” go slay your attributes, periodt ✨

πŸ“¦ where this page comes from