|
| 1 | +from typing import TYPE_CHECKING, Any, Dict, Optional |
| 2 | + |
| 3 | +from splitgraph.core.types import Credentials, Params, TableInfo |
| 4 | +from splitgraph.hooks.data_source.fdw import ForeignDataWrapperDataSource |
| 5 | +from splitgraph.ingestion.common import build_commandline_help |
| 6 | + |
| 7 | +if TYPE_CHECKING: |
| 8 | + from splitgraph.engine.postgres.engine import PostgresEngine |
| 9 | + |
| 10 | + |
| 11 | +class AmazonAthenaDataSource(ForeignDataWrapperDataSource): |
| 12 | + credentials_schema: Dict[str, Any] = { |
| 13 | + "type": "object", |
| 14 | + "properties": { |
| 15 | + "aws_access_key_id": {"type": "string", "title": "AWS Access Key Id"}, |
| 16 | + "aws_secret_access_key": {"type": "string", "title": "AWS Secret Access Key"}, |
| 17 | + }, |
| 18 | + "required": ["aws_access_key_id", "aws_secret_access_key"], |
| 19 | + } |
| 20 | + |
| 21 | + params_schema = { |
| 22 | + "type": "object", |
| 23 | + "properties": { |
| 24 | + "region_name": { |
| 25 | + "type": "string", |
| 26 | + "title": "S3 region", |
| 27 | + "description": "Region of the S3 bucket", |
| 28 | + }, |
| 29 | + "schema_name": { |
| 30 | + "type": "string", |
| 31 | + "title": "Schema", |
| 32 | + "description": "Athena database name", |
| 33 | + }, |
| 34 | + "s3_staging_dir": { |
| 35 | + "title": "S3 results folder", |
| 36 | + "type": "string", |
| 37 | + "description": "Folder for storing query output", |
| 38 | + }, |
| 39 | + }, |
| 40 | + "required": ["region_name", "schema_name", "s3_staging_dir"], |
| 41 | + } |
| 42 | + |
| 43 | + supports_mount = True |
| 44 | + supports_load = True |
| 45 | + supports_sync = False |
| 46 | + |
| 47 | + commandline_help = """Mount a Amazon Athena database. |
| 48 | +
|
| 49 | +This will mount an Athena schema or a table: |
| 50 | +
|
| 51 | +\b |
| 52 | +``` |
| 53 | +$ sgr mount athena s3 -o@- <<EOF |
| 54 | +{ |
| 55 | + "aws_access_key_id": "ABCD", |
| 56 | + "aws_secret_access_key": "abcd", |
| 57 | + "region_name": "eu-west-3", |
| 58 | + "schema_name": "mydatabase", |
| 59 | + "s3_staging_dir": "s3://my-bucket/output/", |
| 60 | +} |
| 61 | +EOF |
| 62 | +``` |
| 63 | + """ |
| 64 | + |
| 65 | + commandline_kwargs_help: str = ( |
| 66 | + build_commandline_help(credentials_schema) + "\n" + build_commandline_help(params_schema) |
| 67 | + ) |
| 68 | + |
| 69 | + _icon_file = "athena.svg" |
| 70 | + |
| 71 | + def __init__( |
| 72 | + self, |
| 73 | + engine: "PostgresEngine", |
| 74 | + credentials: Credentials, |
| 75 | + params: Params, |
| 76 | + tables: Optional[TableInfo] = None, |
| 77 | + ): |
| 78 | + super().__init__(engine, credentials, params, tables) |
| 79 | + |
| 80 | + def get_fdw_name(self): |
| 81 | + return "multicorn" |
| 82 | + |
| 83 | + @classmethod |
| 84 | + def get_name(cls) -> str: |
| 85 | + return "Amazon Athena" |
| 86 | + |
| 87 | + @classmethod |
| 88 | + def get_description(cls) -> str: |
| 89 | + return "Query data in Amazon S3 files and folders" |
| 90 | + |
| 91 | + def get_table_options( |
| 92 | + self, table_name: str, tables: Optional[TableInfo] = None |
| 93 | + ) -> Dict[str, str]: |
| 94 | + result = super().get_table_options(table_name, tables) |
| 95 | + result["tablename"] = result.get("tablename", table_name) |
| 96 | + return result |
| 97 | + |
| 98 | + def get_server_options(self): |
| 99 | + options: Dict[str, Optional[str]] = { |
| 100 | + "wrapper": "multicorn.sqlalchemyfdw.SqlAlchemyFdw", |
| 101 | + "db_url": self._build_db_url(), |
| 102 | + "cast_quals": "true", |
| 103 | + } |
| 104 | + |
| 105 | + # For some reason, in SQLAlchemy, if this is not passed |
| 106 | + # to the FDW params (even if it is in the DB URL), it doesn't |
| 107 | + # schema-qualify tables and server-side cursors don't work for scanning |
| 108 | + # (loads the whole table instead of scrolling through it). |
| 109 | + if "schema" in self.params: |
| 110 | + options["schema"] = self.params["schema"] |
| 111 | + |
| 112 | + return options |
| 113 | + |
| 114 | + def _build_db_url(self) -> str: |
| 115 | + """Construct the SQLAlchemy Amazon Athena db_url""" |
| 116 | + |
| 117 | + aws_access_key_id = self.credentials["aws_access_key_id"] |
| 118 | + aws_secret_access_key = self.credentials["aws_secret_access_key"] |
| 119 | + region_name = self.params["region_name"] |
| 120 | + schema_name = self.params["schema_name"] |
| 121 | + s3_staging_dir = self.params["s3_staging_dir"] |
| 122 | + |
| 123 | + db_url = ( |
| 124 | + f"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@" |
| 125 | + f"athena.{region_name}.amazonaws.com:443/" |
| 126 | + f"{schema_name}?s3_staging_dir={s3_staging_dir}" |
| 127 | + ) |
| 128 | + |
| 129 | + return db_url |
| 130 | + |
| 131 | + def get_remote_schema_name(self) -> str: |
| 132 | + if "schema_name" not in self.params: |
| 133 | + raise ValueError("Cannot IMPORT FOREIGN SCHEMA without a schema_name!") |
| 134 | + return str(self.params["schema_name"]) |
0 commit comments