MetaDB

SQLite

Parameter	Description	Default	Required
path	Path to the sqlite file	-
table	Table name	-
idx	Column containing identifiers	-
geodata	Columns containing geographical data, if applicable	-

sqlite_ex.yaml

metadata:
  type: "sqlite"
  params:
    path: "./metadata.sqlite"
    table: "table"
    idx: "Sample"
    geodata:
      latitude: "Lat"
      longitude: "Long"

sqlite_ex.toml

[databases.Example.metadata]
type = "sqlite"
[databases.Example.metadata.params]
path = "./metadata.sqlite"
table = "table"
idx = "Sample"
geodata = { latitude = "Lat", longitude = "Long"}

TSV File

Parameter	Description	Default	Required
path	Path to the tsv file	-
sep	Separator	'\t'
idx	Column containing identifiers	-
geodata	Columns containing geographical data, if applicable	-

tsv_ex.yaml

metadata:
  type: "tsv"
  params:
    path: "./metadata.tsv"
    sep: "\t"
    idx: "Sample"
    geodata:
      latitude: "Lat"
      longitude: "Long"

tsv_ex.toml

[databases.Example.metadata]
type = "tsv"
[databases.Example.metadata.params]
path = "./metadata.tsv"
sep = "\t"
idx = "Sample"
geodata = { latitude = "Lat", longitude = "Long"}

MySQL / MariaDB

Parameter	Description	Default	Required
host	DB server url	-
user	Username	-
password	Password	-
database	Database name	-
table	Table name	-
port	DB server port	3306
idx	Column containing identifiers	-
geodata	Columns containing geographical data, if applicable	-

mysql_ex.yaml

metadata:
  type: "mysql"
  params:
    host: "localhost"
    user: "root"
    password: "password"
    database: "kmvizdb"
    table: "table"
    geodata:
      latitude: "Lat"
      longitude: "Long"

mysql_ex.toml

[databases.Example.metadata]
type = "mysql"
[databases.Example.metadata.params]
host ="localhost"
user = "root"
password = "password"
database = "kmvizdb"
table = "table"
idx = "Sample"
geodata = { latitude = "Lat", longitude = "Long"}

Parquet

Parameter	Description	Default	Required
files	List of parquet files	-
idx	Column containing identifiers	-
geodata	Columns containing geographical data, if applicable	-

parquet_ex.yaml

metadata:
  type: "parquet"
  params:
    files: ["/path/to/file.parquet"]
    idx: "Sample"
    geodata:
      latitude: "Lat"
      longitude: "Long"

parquet_ex.toml

[databases.Example.metadata]
type = "parquet"
[databases.Example.metadata.params]
files = ["/path/to/file.parquet"]
idx = "Sample"
geodata = { latitude = "Lat", longitude = "Long"}