liana.rs.describe_metalinks

liana.rs.describe_metalinks(db_path=None, return_output=False)

Prints the schema information and foreign key details for all tables in the specified SQLite database.

Parameters:

db_path str | None (default: None)

Path to the SQLite database file. If None, the database will be downloaded to the current working directory.

return_output bool (default: False)

Whether to return the output or just print it.

Return type:

str | None

Returns:

The database schema description.

Examples

This function downloads MetalinksDB on first use, so it is not run here. It prints the tables and columns that liana.rs.get_metalinks() and liana.rs.get_metalinks_values() query:

describe_metalinks()