blob: 2aed06b18ddace39b755d822a2f440d237fdf0dc [file] [log] [blame]
"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[907],{58850:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=a(83117),r=(a(67294),a(3905));const o={title:"Amazon Athena",hide_title:!0,sidebar_position:4,version:1},s=void 0,i={unversionedId:"databases/athena",id:"databases/athena",title:"Amazon Athena",description:"AWS Athena",source:"@site/docs/databases/athena.mdx",sourceDirName:"databases",slug:"/databases/athena",permalink:"/docs/databases/athena",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/databases/athena.mdx",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Amazon Athena",hide_title:!0,sidebar_position:4,version:1},sidebar:"tutorialSidebar",previous:{title:"Using Database Connection UI",permalink:"/docs/databases/db-connection-ui"},next:{title:"Amazon DynamoDB",permalink:"/docs/databases/dynamodb"}},c={},p=[{value:"AWS Athena",id:"aws-athena",level:2},{value:"PyAthenaJDBC",id:"pyathenajdbc",level:3},{value:"PyAthena",id:"pyathena",level:3}],l={toc:p},d="wrapper";function m(e){let{components:t,...a}=e;return(0,r.kt)(d,(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"aws-athena"},"AWS Athena"),(0,r.kt)("h3",{id:"pyathenajdbc"},"PyAthenaJDBC"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://pypi.org/project/PyAthenaJDBC/"},"PyAthenaJDBC")," is a Python DB 2.0 compliant wrapper for the\n",(0,r.kt)("a",{parentName:"p",href:"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html"},"Amazon Athena JDBC driver"),"."),(0,r.kt)("p",null,"The connection string for Amazon Athena is as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}&...\n")),(0,r.kt)("p",null,"Note that you'll need to escape & encode when forming the connection string like so:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"s3://... -> s3%3A//...\n")),(0,r.kt)("h3",{id:"pyathena"},"PyAthena"),(0,r.kt)("p",null,"You can also use ",(0,r.kt)("a",{parentName:"p",href:"https://pypi.org/project/PyAthena/"},"PyAthena library")," (no Java required) with the\nfollowing connection string:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}&...\n")),(0,r.kt)("p",null,"The PyAthena library also allows to assume a specific IAM role, by ",(0,r.kt)("a",{parentName:"p",href:"https://superset.apache.org/docs/miscellaneous/importing-exporting-datasources/#importing-datasources-from-yaml"},"importing the datasource from YAML")," and passing extra parameters:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'databases:\n - database_name: awsathena\n sqlalchemy_uri: awsathena+rest://athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}&...\n extra: "{\\"engine_params\\": {\\"connect_args\\": {\\"role_arn\\": \\"{{ ROLE_ARN }}\\" }}}"\n')))}m.isMDXComponent=!0},3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>u});var n=a(67294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?o(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):o(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function i(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},o=Object.keys(e);for(n=0;n<o.length;n++)a=o[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)a=o[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var c=n.createContext({}),p=function(e){var t=n.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},l=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=p(a),h=r,u=d["".concat(c,".").concat(h)]||d[h]||m[h]||o;return a?n.createElement(u,s(s({ref:t},l),{},{components:a})):n.createElement(u,s({ref:t},l))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,s=new Array(o);s[0]=h;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:r,s[1]=i;for(var p=2;p<o;p++)s[p]=a[p];return n.createElement.apply(null,s)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"}}]);