Athena

AthenaReader

基础类: BaseReader

Athena 读取器。

请遵循 AWS 安全最佳实践。AWS 不鼓励在代码中硬编码凭证。我们建议您使用 IAM 角色而不是 IAM 用户凭证。如果您必须使用凭证，请不要将其嵌入代码中。相反，请将其存储在环境变量或单独的配置文件中。

源代码位于 llama-index-integrations/readers/llama-index-readers-athena/llama_index/readers/athena/base.py

class AthenaReader(BaseReader):
    """
    Athena reader.

    Follow AWS best practices for security.
    AWS discourages hardcoding credentials in code.
    We recommend that you use IAM roles instead of IAM user credentials.
    If you must use credentials, do not embed them in your code.
    Instead, store them in environment variables or in a separate configuration file.

    """

    def __init__(
        self,
    ) -> None:
        """Initialize with parameters."""

    def create_athena_engine(
        self,
        aws_access_key: Optional[str] = None,
        aws_secret_key: Optional[str] = None,
        aws_region: str = None,
        s3_staging_dir: str = None,
        database: str = None,
        workgroup: str = None,
    ):
        """
        Args:
        aws_access_key is the AWS access key from aws credential
        aws_secret_key is the AWS secret key from aws credential
        aws_region is the AWS region
        s3_staging_dir is the S3 staging (result bucket) directory
        database is the Athena database name
        workgroup is the Athena workgroup name.

        """
        if not aws_access_key or not aws_secret_key:
            conn_str = (
                "awsathena+rest://:@athena.{region_name}.amazonaws.com:443/"
                "{database}?s3_staging_dir={s3_staging_dir}?work_group={workgroup}"
            )

            engine = create_engine(
                conn_str.format(
                    region_name=aws_region,
                    s3_staging_dir=s3_staging_dir,
                    database=database,
                    workgroup=workgroup,
                )
            )

        else:
            warnings.warn(
                "aws_access_key and aws_secret_key are set. We recommend to use IAM role instead."
            )
            boto3.client(
                "athena",
                aws_access_key_id=aws_access_key,
                aws_secret_access_key=aws_secret_key,
                region_name=aws_region,
            )

            conn_str = (
                "awsathena+rest://:@athena.{region_name}.amazonaws.com:443/"
                "{database}?s3_staging_dir={s3_staging_dir}?work_group={workgroup}"
            )

            engine = create_engine(
                conn_str.format(
                    region_name=aws_region,
                    s3_staging_dir=s3_staging_dir,
                    database=database,
                    workgroup=workgroup,
                )
            )
        return engine

create_athena_engine

create_athena_engine(aws_access_key: Optional[str] = None, aws_secret_key: Optional[str] = None, aws_region: str = None, s3_staging_dir: str = None, database: str = None, workgroup: str = None)

参数: aws_access_key 是来自 AWS 凭证的 AWS 访问密钥，aws_secret_key 是来自 AWS 凭证的 AWS 秘密密钥，aws_region 是 AWS 区域，s3_staging_dir 是 S3 暂存（结果桶）目录，database 是 Athena 数据库名称，workgroup 是 Athena 工作组名称。

源代码位于 llama-index-integrations/readers/llama-index-readers-athena/llama_index/readers/athena/base.py

def create_athena_engine(
    self,
    aws_access_key: Optional[str] = None,
    aws_secret_key: Optional[str] = None,
    aws_region: str = None,
    s3_staging_dir: str = None,
    database: str = None,
    workgroup: str = None,
):
    """
    Args:
    aws_access_key is the AWS access key from aws credential
    aws_secret_key is the AWS secret key from aws credential
    aws_region is the AWS region
    s3_staging_dir is the S3 staging (result bucket) directory
    database is the Athena database name
    workgroup is the Athena workgroup name.

    """
    if not aws_access_key or not aws_secret_key:
        conn_str = (
            "awsathena+rest://:@athena.{region_name}.amazonaws.com:443/"
            "{database}?s3_staging_dir={s3_staging_dir}?work_group={workgroup}"
        )

        engine = create_engine(
            conn_str.format(
                region_name=aws_region,
                s3_staging_dir=s3_staging_dir,
                database=database,
                workgroup=workgroup,
            )
        )

    else:
        warnings.warn(
            "aws_access_key and aws_secret_key are set. We recommend to use IAM role instead."
        )
        boto3.client(
            "athena",
            aws_access_key_id=aws_access_key,
            aws_secret_access_key=aws_secret_key,
            region_name=aws_region,
        )

        conn_str = (
            "awsathena+rest://:@athena.{region_name}.amazonaws.com:443/"
            "{database}?s3_staging_dir={s3_staging_dir}?work_group={workgroup}"
        )

        engine = create_engine(
            conn_str.format(
                region_name=aws_region,
                s3_staging_dir=s3_staging_dir,
                database=database,
                workgroup=workgroup,
            )
        )
    return engine