populate_metadata

langroid/agent/special/sql/utils/populate_metadata.py

populate_metadata_with_schema_tools(metadata, info)

Extracts information from an SQLAlchemy database's metadata and combines it with another dictionary with context descriptions.

Parameters:

Name	Type	Description	Default
metadata	MetaData	SQLAlchemy metadata object of the database.	required
info	Dict[str, Dict[str, Any]]	A dictionary with table and column descriptions.	required

Returns:

Type	Description
Dict[str, Dict[str, Union[str, Dict[str, str]]]]	Dict[str, Dict[str, Any]]: A dictionary with table and context information.

Source code in langroid/agent/special/sql/utils/populate_metadata.py

def populate_metadata_with_schema_tools(
    metadata: MetaData | List[MetaData],
    info: Dict[str, Dict[str, Union[str, Dict[str, str]]]],
) -> Dict[str, Dict[str, Union[str, Dict[str, str]]]]:
    """
    Extracts information from an SQLAlchemy database's metadata and combines it
    with another dictionary with context descriptions.

    Args:
        metadata (MetaData): SQLAlchemy metadata object of the database.
        info (Dict[str, Dict[str, Any]]): A dictionary with table and column
                                             descriptions.

    Returns:
        Dict[str, Dict[str, Any]]: A dictionary with table and context information.
    """
    db_info: Dict[str, Dict[str, Union[str, Dict[str, str]]]] = {}

    def populate_metadata(md: MetaData) -> None:
        # Create empty metadata dictionary with column datatypes
        for table_name, table in md.tables.items():
            # Populate tables with empty descriptions
            db_info[table_name] = {
                "description": info[table_name]["description"] or "",
                "columns": {},
            }

            for column in table.columns:
                # Populate columns with datatype
                db_info[table_name]["columns"][str(column.name)] = (  # type: ignore
                    str(column.type)
                )

    if isinstance(metadata, list):
        for md in metadata:
            populate_metadata(md)
    else:
        populate_metadata(metadata)

    return db_info

populate_metadata(metadata, info)

Populate metadata based on the provided database metadata and additional info.

Parameters:

Name	Type	Description	Default
metadata	MetaData	Metadata object from SQLAlchemy.	required
info	Dict	Additional information for database tables and columns.	required

Returns:

Name	Type	Description
Dict	Dict[str, Dict[str, Union[str, Dict[str, str]]]]	A dictionary containing populated metadata information.

Source code in langroid/agent/special/sql/utils/populate_metadata.py

def populate_metadata(
    metadata: MetaData | List[MetaData],
    info: Dict[str, Dict[str, Union[str, Dict[str, str]]]],
) -> Dict[str, Dict[str, Union[str, Dict[str, str]]]]:
    """
    Populate metadata based on the provided database metadata and additional info.

    Args:
        metadata (MetaData): Metadata object from SQLAlchemy.
        info (Dict): Additional information for database tables and columns.

    Returns:
        Dict: A dictionary containing populated metadata information.
    """
    # Fetch basic metadata info using available tools
    db_info: Dict[str, Dict[str, Union[str, Dict[str, str]]]] = (
        populate_metadata_with_schema_tools(metadata=metadata, info=info)
    )

    # Iterate over tables to update column metadata
    for table_name in db_info.keys():
        # Update only if additional info for the table exists
        if table_name in info:
            for column_name in db_info[table_name]["columns"]:
                # Merge and update column description if available
                if column_name in info[table_name]["columns"]:
                    db_info[table_name]["columns"][column_name] = (  # type: ignore
                        db_info[table_name]["columns"][column_name]  # type: ignore
                        + "; "
                        + info[table_name]["columns"][column_name]  # type: ignore
                    )

    return db_info